Node / meshtastic / Meshtastic-Android / files / feature / connections / src / commonTest / kotlin / org / meshtastic / feature / connections / ScannerViewModelHarness.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.connections

Tff7b72import T7ee787androidx.lifecycle.ViewModel

Tff7b72import T7ee787androidx.lifecycle.viewModelScope

Tff7b72import T7ee787dev.mokkery.MockMode

Tff7b72import T7ee787dev.mokkery.answering.returns

Tff7b72import T7ee787dev.mokkery.every

Tff7b72import T7ee787dev.mokkery.matcher.any

Tff7b72import T7ee787dev.mokkery.mock

Tff7b72import T7ee787kotlinx.coroutines.ExperimentalCoroutinesApi

Tff7b72import T7ee787kotlinx.coroutines.awaitCancellation

Tff7b72import T7ee787kotlinx.coroutines.cancel

Tff7b72import T7ee787kotlinx.coroutines.flow.Flow

Tff7b72import T7ee787kotlinx.coroutines.flow.MutableStateFlow

Tff7b72import T7ee787kotlinx.coroutines.flow.combine

Tff7b72import T7ee787kotlinx.coroutines.flow.flow

Tff7b72import T7ee787kotlinx.coroutines.flow.flowOf

Tff7b72import T7ee787kotlinx.coroutines.test.TestDispatcher

Tff7b72import T7ee787kotlinx.coroutines.test.UnconfinedTestDispatcher

Tff7b72import T7ee787org.meshtastic.core.ble.BleDevice

Tff7b72import T7ee787org.meshtastic.core.ble.BleScanner

Tff7b72import T7ee787org.meshtastic.core.datastore.FirmwareRecoveryDataSource

Tff7b72import T7ee787org.meshtastic.core.datastore.RecentAddressesDataSource

Tff7b72import T7ee787org.meshtastic.core.di.CoroutineDispatchers

Tff7b72import T7ee787org.meshtastic.core.network.repository.DiscoveredService

Tff7b72import T7ee787org.meshtastic.core.network.repository.NetworkRepository

Tff7b72import T7ee787org.meshtastic.core.repository.RadioInterfaceService

Tff7b72import T7ee787org.meshtastic.core.repository.RadioPrefs

Tff7b72import T7ee787org.meshtastic.core.testing.FakeBleDevice

Tff7b72import T7ee787org.meshtastic.core.testing.FakeBluetoothRepository

Tff7b72import T7ee787org.meshtastic.core.testing.FakeRadioController

Tff7b72import T7ee787org.meshtastic.core.testing.FakeServiceRepository

Tff7b72import T7ee787org.meshtastic.core.testing.FakeUiPrefs

Tff7b72import T7ee787org.meshtastic.feature.connections.model.DeviceListEntry

Tff7b72import T7ee787org.meshtastic.feature.connections.model.DiscoveredDevices

Tff7b72import T7ee787org.meshtastic.feature.connections.model.GetDiscoveredDevicesUseCase

T8b949e/**

* Reusable construction harness for [ScannerViewModel] (and its platform subclasses).

*

* Bundles the ~10 collaborators the ViewModel needs — hand-written fakes where assertions are made ([radioController],

* [serviceRepository], [bluetoothRepository]) and Mokkery autofill mocks for the peripheral ones — plus the common

* init-time stubbing, so a test only writes the bits it actually asserts on. Lives in `commonTest` so both the

* platform-neutral test and the `androidHostTest` subclass tests can reuse it (the KMP default hierarchy makes

* `androidHostTest` depend on `commonTest`).

*

* Usage: construct the harness, `Dispatchers.setMain(harness.testDispatcher)`, then [buildBase] (platform-neutral) or

* build a platform subclass from the exposed collaborators (see `AndroidScannerViewModelBondingTest`).

*/

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalCoroutinesApiTff7b72::Te6edf3classTb4b4b4)

Tff7b72class T56d364ScannerViewModelHarnessTb4b4b4(Tff7b72val Te6edf3testDispatcherTb4b4b4: Te6edf3TestDispatcher Tff7b72= Te6edf3UnconfinedTestDispatcherTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3serviceRepository Tff7b72= Te6edf3FakeServiceRepositoryTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3radioController Tff7b72= Te6edf3FakeRadioControllerTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3bluetoothRepository Tff7b72= Te6edf3FakeBluetoothRepositoryTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3uiPrefs Tff7b72= Te6edf3FakeUiPrefsTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3radioInterfaceServiceTb4b4b4: Te6edf3RadioInterfaceService Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

Tff7b72val Te6edf3radioPrefsTb4b4b4: Te6edf3RadioPrefs Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

Tff7b72val Te6edf3recentAddressesDataSourceTb4b4b4: Te6edf3RecentAddressesDataSource Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

Tff7b72val Te6edf3firmwareRecoveryDataSourceTb4b4b4: Te6edf3FirmwareRecoveryDataSource Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

Tff7b72val Te6edf3networkRepositoryTb4b4b4: Te6edf3NetworkRepository Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

Tff7b72val Te6edf3bleScannerTb4b4b4: Te6edf3BleScanner Tff7b72= Te6edf3mockTb4b4b4(Te6edf3MockModeTb4b4b4.Te6edf3autofillTb4b4b4)

T8b949e/** Drives the base device list (bonded BLE / USB / TCP) for tests that exercise the discovery flows. */

Tff7b72val Te6edf3baseDevicesFlow Tff7b72= Te6edf3MutableStateFlowTb4b4b4(Te6edf3DiscoveredDevicesTb4b4b4(Tb4b4b4)Tb4b4b4)

T8b949e/** NSD-resolved services, gated by the network-scan flag in the ViewModel. */

Tff7b72val Te6edf3resolvedServicesFlow Tff7b72= Te6edf3MutableStateFlowTff7b72<Te6edf3ListTff7b72<Te6edf3DiscoveredServiceTff7b72>Tff7b72>Tb4b4b4(Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4)

T8b949e/**

* Currently-selected device address (the `fullAddress`), backing `radioInterfaceService.currentDeviceAddressFlow`.

*/

Tff7b72val Te6edf3currentDeviceAddressFlow Tff7b72= Te6edf3MutableStateFlowTff7b72<Tffa657String?Tff7b72>Tb4b4b4(Tff7b72nullTb4b4b4)

T8b949e/** Demo Mode gate, backing `radioInterfaceService.mockTransportEnabled`. Flip it to assert the reactive path. */

Tff7b72val Te6edf3mockTransportEnabled Tff7b72= Te6edf3MutableStateFlowTb4b4b4(Tff7b72falseTb4b4b4)

Tff7b72val Te6edf3dispatchers Tff7b72= Te6edf3CoroutineDispatchersTb4b4b4(Te6edf3io Tff7b72= Te6edf3testDispatcherTb4b4b4, Te6edf3main Tff7b72= Te6edf3testDispatcherTb4b4b4, Te6edf3default Tff7b72= Te6edf3testDispatcherTb4b4b4)

T8b949e/**

* The `(showMock, showReplay)` pairs the ViewModel has asked for, in call order. Without this the fake would return

* the same devices for every visibility combination, so a test could pass while the ViewModel requested the wrong

* one — assert against this to prove the production path actually forwarded the intended flags.

*

* The order matters as much as the contents: the Demo Mode gate is observed rather than sampled, so a mid-session

* unlock has to show up here as a fresh request.

*/

Tff7b72val Te6edf3discoveryRequests Tff7b72= Te6edf3mutableListOfTff7b72<Te6edf3PairTff7b72<Tffa657BooleanTb4b4b4, Tffa657BooleanTff7b72>Tff7b72>Tb4b4b4(Tb4b4b4)

T8b949e/**

* A fake [GetDiscoveredDevicesUseCase] that mirrors the real behavior: it combines [baseDevicesFlow] with the

* provided resolved list so tests can verify NSD gating, and records each request in [discoveryRequests].

*/

Tff7b72val Te6edf3getDiscoveredDevicesUseCase Tff7b72=

Tff7b72object Tb4b4b4: T56d364GetDiscoveredDevicesUseCase Tb4b4b4{

Tff7b72override Tff7b72fun Td2a8ffinvokeTb4b4b4(

Te6edf3showMockTb4b4b4: Tffa657BooleanTb4b4b4,

Te6edf3showReplayTb4b4b4: Tffa657BooleanTb4b4b4,

Te6edf3resolvedListTb4b4b4: Te6edf3FlowTff7b72<Te6edf3ListTff7b72<Te6edf3DiscoveredServiceTff7b72>Tff7b72>Tb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3FlowTff7b72<Te6edf3DiscoveredDevicesTff7b72> Tb4b4b4{

Te6edf3discoveryRequests Tff7b72+Tff7b72= Te6edf3showMock Te6edf3to Te6edf3showReplay

Tff7b72return Te6edf3combineTb4b4b4(Te6edf3baseDevicesFlowTb4b4b4, Te6edf3resolvedListTb4b4b4) Tb4b4b4{ Te6edf3baseTb4b4b4, Te6edf3resolved Tff7b72-Tff7b72>

Tff7b72val Te6edf3tcpDevices Tff7b72=

Te6edf3resolvedTb4b4b4.Te6edf3map Tb4b4b4{ Te6edf3DeviceListEntryTb4b4b4.Te6edf3TcpTb4b4b4(Te6edf3name Tff7b72= Tffa657itTb4b4b4.Te6edf3nameTb4b4b4, Te6edf3fullAddress Tff7b72= Ta5d6ff"Ta5d6fftTffd700${Tffa657itTb4b4b4.Te6edf3hostAddressTffd700}Ta5d6ff"Tb4b4b4) Tb4b4b4}

Te6edf3baseTb4b4b4.Te6edf3copyTb4b4b4(Te6edf3discoveredTcpDevices Tff7b72= Te6edf3tcpDevicesTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

Tff7b72init Tb4b4b4{

Te6edf3every Tb4b4b4{ Te6edf3radioInterfaceServiceTb4b4b4.Te6edf3mockTransportEnabled Tb4b4b4} Te6edf3returns Te6edf3mockTransportEnabled

Te6edf3every Tb4b4b4{ Te6edf3radioInterfaceServiceTb4b4b4.Te6edf3isReplayTransportAvailable Tb4b4b4} Te6edf3returns Tff7b72false

Te6edf3every Tb4b4b4{ Te6edf3radioInterfaceServiceTb4b4b4.Te6edf3currentDeviceAddressFlow Tb4b4b4} Te6edf3returns Te6edf3currentDeviceAddressFlow

Te6edf3every Tb4b4b4{ Te6edf3recentAddressesDataSourceTb4b4b4.Te6edf3recentAddresses Tb4b4b4} Te6edf3returns Te6edf3MutableStateFlowTb4b4b4(Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4)

Te6edf3every Tb4b4b4{ Te6edf3firmwareRecoveryDataSourceTb4b4b4.Te6edf3pending Tb4b4b4} Te6edf3returns Te6edf3flowOfTb4b4b4(Tff7b72nullTb4b4b4)

Te6edf3every Tb4b4b4{ Te6edf3networkRepositoryTb4b4b4.Te6edf3resolvedList Tb4b4b4} Te6edf3returns Te6edf3resolvedServicesFlow

Te6edf3every Tb4b4b4{ Te6edf3networkRepositoryTb4b4b4.Te6edf3networkAvailable Tb4b4b4} Te6edf3returns Te6edf3flowOfTb4b4b4(Tff7b72trueTb4b4b4)

T8b949e// Default: a non-completing scan flow so the BLE scan stays "active" until explicitly cancelled.

T8b949e// Under UnconfinedTestDispatcher an emptyFlow().collect{} returns immediately and would flip

T8b949e// _isBleScanning back to false before startBleScan() returns. Tests that need specific emissions

T8b949e// (e.g. device-list updates) override this stub.

Te6edf3every Tb4b4b4{ Te6edf3bleScannerTb4b4b4.Te6edf3scanTb4b4b4(Te6edf3anyTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3anyTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4} Te6edf3returns Te6edf3flowTff7b72<Te6edf3BleDeviceTff7b72> Tb4b4b4{ Te6edf3awaitCancellationTb4b4b4(Tb4b4b4) Tb4b4b4}

Tb4b4b4}

T8b949e/**

* Build the platform-neutral [ScannerViewModel]. Call only after `Dispatchers.setMain(testDispatcher)` because the

* ViewModel's `init` launches work on `viewModelScope` (Main).

*/

Tff7b72fun Td2a8ffbuildBaseTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3ScannerViewModel Tff7b72= Te6edf3ScannerViewModelTb4b4b4(

Te6edf3serviceRepository Tff7b72= Te6edf3serviceRepositoryTb4b4b4,

Te6edf3radioController Tff7b72= Te6edf3radioControllerTb4b4b4,

Te6edf3radioInterfaceService Tff7b72= Te6edf3radioInterfaceServiceTb4b4b4,

Te6edf3radioPrefs Tff7b72= Te6edf3radioPrefsTb4b4b4,

Te6edf3recentAddressesDataSource Tff7b72= Te6edf3recentAddressesDataSourceTb4b4b4,

Te6edf3getDiscoveredDevicesUseCase Tff7b72= Te6edf3getDiscoveredDevicesUseCaseTb4b4b4,

Te6edf3networkRepository Tff7b72= Te6edf3networkRepositoryTb4b4b4,

Te6edf3dispatchers Tff7b72= Te6edf3dispatchersTb4b4b4,

Te6edf3uiPrefs Tff7b72= Te6edf3uiPrefsTb4b4b4,

Te6edf3firmwareRecoveryDataSource Tff7b72= Te6edf3firmwareRecoveryDataSourceTb4b4b4,

Te6edf3bleScanner Tff7b72= Te6edf3bleScannerTb4b4b4,

Tb4b4b4)

T8b949e/**

* Ends [viewModel]'s lifetime. Call from `@AfterTest` **before** `Dispatchers.resetMain()`.

*

* `viewModelScope` is never cleared for a hand-built ViewModel, so without this its coroutines outlive the test.

* One suspended on a real-dispatcher result (compose-resources resolves on an internal `Dispatchers.Default` scope)

* then resumes onto a `Dispatchers.Main` that `resetMain()` has already unset, which throws. Nothing handles it, so

* it lands as `UncaughtExceptionsBeforeTest` on whichever test starts next.

*/

Tff7b72fun Td2a8ffclearViewModelTb4b4b4(Te6edf3viewModelTb4b4b4: Te6edf3ViewModelTb4b4b4) Tb4b4b4{

Te6edf3viewModelTb4b4b4.Te6edf3viewModelScopeTb4b4b4.Te6edf3cancelTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tff7b72companion Tff7b72object Tb4b4b4{

T8b949e/** A scanned-but-unbonded BLE entry — the input that routes through `requestBonding`. */

Tff7b72fun Td2a8ffunbondedBleEntryTb4b4b4(Te6edf3addressTb4b4b4: Tffa657StringTb4b4b4, Te6edf3nameTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ffNodeTa5d6ff"Tb4b4b4)Tb4b4b4: Te6edf3DeviceListEntryTb4b4b4.Te6edf3Ble Tff7b72=

Te6edf3DeviceListEntryTb4b4b4.Te6edf3BleTb4b4b4(Te6edf3device Tff7b72= Te6edf3FakeBleDeviceTb4b4b4(Te6edf3address Tff7b72= Te6edf3addressTb4b4b4, Te6edf3name Tff7b72= Te6edf3nameTb4b4b4)Tb4b4b4, Te6edf3bonded Tff7b72= Tff7b72falseTb4b4b4)

Tb4b4b4}

Tb4b4b4}